<!DOCTYPE html>
<html>

<head>
    <title><p>Stat plot combine with the MS-imaging</p></title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
    <link rel="stylesheet" type="text/css" href="https://mzkit.org/assets/js/page.css">
</head>

<body>
    <div class="container">

        <table style="width: 100%;">
            <tr>
                <td>MSI_ionStatPlot {MSImaging}</td>
                <td style="text-align: right;">R Documentation</td>
            </tr>
        </table>

        <h2><p>Stat plot combine with the MS-imaging</p></h2>

        <h3>Description</h3>

        

        <h3>Usage</h3>

        <div style="width: 100%; padding-left: 3%; color: black;">
            <pre><code class='language-R' style="color: black; font-weight:normal;"><strong>MSI_ionStatPlot</strong>(<i>mzpack</i>, <i>mz</i>, <i>met</i>, <i>sampleinfo</i>,
    <i>savePng</i> = <span style='color: brown;'><strong>'./Rplot.png'</strong></span>,
    <i>ionName</i> = <span style='color: blue !important;'>NULL</span>,
    <i>size</i> = [<span style='color: green;'>1000</span>],
    <i>colorMap</i> = <span style='color: blue !important;'>NULL</span>,
    <i>MSI.colorset</i> = <span style='color: brown;'><strong>'viridis:turbo'</strong></span>,
    <i>ggStatPlot</i> = <span style='color: blue !important;'>NULL</span>,
    <i>padding.top</i> = <span style='color: green;'>150</span>,
    <i>padding.right</i> = <span style='color: green;'>200</span>,
    <i>padding.bottom</i> = <span style='color: green;'>150</span>,
    <i>padding.left</i> = <span style='color: green;'>150</span>,
    <i>interval</i> = <span style='color: green;'>50</span>,
    <i>combine.layout</i> = [<span style='color: green;'>5</span>],
    <i>jitter.size</i> = <span style='color: green;'>8</span>,
    <i>TrIQ</i> = <span style='color: green;'>0.65</span>,
    <i>backcolor</i> = <span style='color: #000000;'><strong>'black'</strong></span>,
    <i>regions</i> = <span style='color: blue !important;'>NULL</span>);</code></pre>
        </div>

        <h3>Arguments</h3>

        <table>
            
<dt>mzpack</dt>
<dd><p><p>a mzpack data object used for do MS-imaging or other data object that contains the ms-imaging layer data and could be recognized by the ggplot ms-imaging function.</p></p></dd>


<dt>ionName</dt>
<dd><p><p>the display title string. the ion m/z value will be used if this parameter leaves default NULL.</p></p></dd>


<dt>mz</dt>
<dd><p><p>the target ion m/z value.</p></p></dd>


<dt>met</dt>
<dd><p><p>should be a list data object that contains the sample data, which this list the key names is the sample id set and the corresponding element value is the sample intensity value.</p></p></dd>


<dt>sampleinfo</dt>
<dd><p><p>a data list set which could be used for defined the sample group information and the plot color value. this list data should be contains at least 3 required data fields: 1. group: the sample group name, used for display as the title label of each group data 2. id: a character vector that contains the necessary sample id reference to get the required sample data for each data group 3. color: a single character string value in html color format for specific the color of the bar/box/violin stat plot.</p></p></dd>


<dt>colorMap</dt>
<dd><p><p>a list object that contains the color set value that used for rendering the stat chartting, example as box/bar/violin. this list data object the key names should be the sample group tag and the corresponding value must be the sample intensity data value.</p></p></dd>


<dt>MSI.colorset</dt>
<dd><p><p>the color map name for do MS-imaging rendering, default color scale name is <code>viridis:turbo</code>.</p></p></dd>


<dt>ggStatPlot</dt>
<dd><p><p>default is bar plot.</p></p></dd>


<dt>combine.layout</dt>
<dd><p><p>the layout of the stat charting and the MS-imaging plot. a numeric vector that contains two value element, first is the width percentage of the stats chart and the second one is the width percentage of the single ion ms-imaging.</p></p></dd>


<dt>savePng</dt>
<dd><p><p>the filepath to save the image plot output.</p></p></dd>


<dt>backcolor</dt>
<dd><p><p>the background color of the MS-imaging plot</p></p></dd>

        </table>


        <h3 style="display: none;">Details</h3>

        

        <h3 style="display: block">Authors</h3>

        xieguigang

        <h3>Value</h3>

        This function has no value returns.

        <h3 style="display: none;">Examples</h3>

        

        <hr />
        <div style="text-align: center;">[Package <em>MSImaging</em> version 0.1.0 <a
                href="../MSImaging.html">Index</a>]
        </div>
    </div>
</body>

<script type="text/javascript" src="https://mzkit.org/assets/js/R_syntax.js"></script>
<script type="text/javascript" src="https://mzkit.org/assets/js/highlights.js"></script>
<script type="text/javascript">r_highlights("example_r");</script>

</html>